Loading TOC...

PUT /manage/v2/clusters/{id|name}/properties

Summary

This resource address modifies the properties of the named foreign cluster. Any change to a foreign bootstrap host will be treated as an attempt to recouple.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This parameter overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the returned data. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 204 (No content). If the payload is malformed or the foreign cluster does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The modifiable properties are as follows.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, foreign-bootstrap-hosts is expressed in singular form. For example, in JSON, foreign-bootstrap-hosts is instead foreign-bootstrap-host and the format is: "foreign-bootstrap-host":[{"foreign-host-id", "foreign-host-name", "foreign-connect-port"}].

foreign-cluster-id

The ID of the foreign cluster.

foreign-cluster-name

The name of the foreign cluster.

xdqp-timeout

The XDQP protocol timeout, in seconds.

host-timeout

The host response timeout, in seconds.

foreign-ssl-certificate

The SSL certificate for the foreign cluster.

xdqp-ssl-enabled

Whether or not SSL is enabled for XDQP.

xdqp-ssl-allow-sslv3

Whether or not SSLv3 is allowed for XDQP (Deprecated).

xdqp-ssl-allow-tls

Whether or not TLS is allowed for XDQP.

xdqp-ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

foreign-bootstrap-hosts

Information about foreign hosts.

This is a complex structure with the following children:

foreign-bootstrap-host

Information related to a particular foreign host.

This is a complex structure with the following children:

foreign-host-id

The ID of the foreign host.

foreign-host-name

The name of the foreign host.

foreign-connect-port

The distributed protocol client socket connect internet port number.

foreign-protocol

foreign protocol.

Example


curl -X PUT --anyauth -u admin:admin --header "Content-Type:application/json" \
-d '{"xdqp-ssl-allow-sslv3":false}' \
http://localhost:8002/manage/v2/clusters/127.0.0.2-cluster/properties

==>  Sets the "xdqp-ssl-allow-sslv3" property to false on the 
     foreign cluster, "127.0.0.2-cluster."

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.